Code Review Analysis

Walkthrough

This PR transitions the Plane Node SDK from auto-generated OpenAPI clients to a handcrafted architecture. It removes all generated APIs and models, introduces Configuration and BaseResource foundation classes, implements organized API resource classes for each domain, adds OAuth client support, and includes updated build tooling and comprehensive documentation.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PlaneClient
    participant Resource as API Resource<br/>(extends BaseResource)
    participant Axios
    participant API as Plane API

    User->>PlaneClient: new PlaneClient(config)
    activate PlaneClient
    PlaneClient->>PlaneClient: Create Configuration
    PlaneClient->>PlaneClient: Initialize all Resources
    PlaneClient-->>User: Ready
    deactivate PlaneClient

    User->>PlaneClient: client.projects.list()
    activate PlaneClient
    PlaneClient->>Resource: list(workspaceSlug)
    activate Resource
    Resource->>Resource: buildUrl(endpoint)
    Resource->>Resource: getHeaders() with auth
    Note over Resource: Intercept request/response if enableLogging
    Resource->>Axios: get(url, {headers, params})
    activate Axios
    Axios->>API: GET /api/v1/workspaces/{...}/projects/
    activate API
    API-->>Axios: 200 { projects: [...] }
    deactivate API
    Axios-->>Resource: response
    deactivate Axios
    Note over Resource: Log if enableLogging enabled
    Resource->>Resource: handleError (if error)
    Resource-->>PlaneClient: PaginatedResponse<Project>
    deactivate Resource
    PlaneClient-->>User: result
    deactivate PlaneClient

    rect rgba(100, 200, 100, 0.3)
        Note over Resource,Axios: New Architecture<br/>- Custom BaseResource<br/>- Axios for HTTP<br/>- Centralized auth/logging<br/>- Error translation to HttpError
    end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60–90 minutes

Specific areas requiring extra attention:

• BaseResource HTTP implementation (src/api/BaseResource.ts): Verify error handling, authentication header assembly, interceptor logic, and sanitization of sensitive data in logs.
• Configuration validation (src/Configuration.ts): Ensure apiKey/accessToken validation logic is correct and covers all required scenarios.
• PlaneClient initialization (src/client/plane-client.ts): Confirm all API resources are correctly instantiated and accessible through the facade.
• OAuth client rewrite (src/client/oauth-client.ts): Review token exchange flow, Basic auth encoding, and error handling—significant shift from runtime.BaseAPI to Axios.
• API resource methods consistency: Verify URL construction patterns, parameter handling, and return types are consistent across all resource classes (Projects, WorkItems, Cycles, etc.).
• Model definitions: Check that new simplified models (src/models/Cycle.ts, src/models/Epic.ts, etc.) correctly replace removed generated models and that imports/dependencies are resolved.
• Package.json changes: Validate new dependencies (axios, ts-jest), engine requirements (Node >=20), and script definitions align with CI/CD workflow.
• GitHub Actions workflow: Ensure build, lint, format, and test steps execute in correct sequence and that all linting/formatting tools are properly configured.

Possibly related PRs

• feat: publish sdk 0.1.5 with below changes #4: Parallel PR touching similar API surfaces (Epics, Pages, Workspaces) and models (AccessBd4Enum); establishes context for generated API deprecation and custom resource architecture.

Suggested reviewers

• Saurabhkmr98

Poem

🐰 From generated code's cascade, a clean SDK does rise,
BaseResource holds the secrets, Axios powers the skies,
PlaneClient greets all resources with open arms so wide,
TypeScript types keep us honest, with Config as our guide,
Handcrafted paths replace the noise—a maintainer's delight! ✨

Pre-merge checks and finishing touches

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}